<ol class="breadcrumb">
    <li><a href="#/">Home</a></li>
    <li class="active">关于犀鸟</li>
</ol>


<h2>什么是犀鸟?</h2>

<p>犀鸟是一个在线文档系统，致力于快速解决团队内部接口文档的编写和沉淀。你可以从 <a href="https://github.com/edgeSuperman/hornibills">https://github.com/edgeSuperman/hornibills</a>获取源码 </p>

<p>力求用最简单的方式部署您的文档系统，拥有最方便的文档管理。

</p>

<p>一些想法借鉴了<a href="http://github.com/mashery/iodocs">iodocs</a>

</p>

<h2>犀鸟如何部署？</h2>

<p>犀鸟采用<strong>bootstrap</strong>+<strong>angularjs</strong>+<strong>php</strong>开发。

</p>

<p>获取源文件，部署到您支持php的webserver的可访问目录即可。

</p>

<p>enjoy!

</p>
<h2>常见问题</h2>
<h3>如何解决版本问题？</h3>
      <p>
          每次修改动作触发后，都会在 <strong>data/</strong> 目录下留下修改文件的一个快照。
      </p>
        <p>例如： <strong>data/type[2013-12-29]1388326575.json</strong>  ，适当人工就可以操作一次回滚，或者diff下修改。</p>
<h3>我有很多现成的接口在word里，我如何快速弄到犀鸟里?</h3>

<p>犀鸟没有db，所有接口在<strong>data/各种.json</strong>里维护。

</p>

<p><strong>data/type.json</strong>是一个特殊的json，里面存储的是您接口的分类，格式简单

</p>
<pre><code class="lang-javascript">[{"name":"notes模块文档","href":"notes","description":"123"},...]</code></pre>
<p>其中href是当前分类的类似主键的东西。

</p>

<p>那么<strong>data/notes.json</strong>对应此分类，维护此分类下的所有接口，样例如下:

</p>
<pre><code class="lang-javascript">
    [
        {
            "name": "一个接口的名字",
            "url": "该接口的url",
            "method": "POST",
            "description": " 接口的描述",
            "params": [
                {
                    "Name": "param_1_name",
                    "Required": "Y",
                    "Default": "",
                    "Type": "string",
                    "Description": "Description of the first parameter."
                },
                {
                    "Name": "userId",
                    "Required": "Y",
                    "Default": "",
                    "Type": "string",
                    "Description": "The userId parameter that is in the URI."
                }
            ],
            "response": [
                {
                    "Name": "param_1_name",
                    "Required": "Y",
                    "Default": "",
                    "Type": "string",
                    "Description": "Description of the first parameter."
                },
                {
                    "Name": "userId",
                    "Required": "Y",
                    "Default": "",
                    "Type": "string",
                    "Description": "The userId parameter that is in the URI."
                }
            ],
            "demo": "&lt;?php \n\r var_dump(123);"
        }
    ]</code></pre>
<p>聪明的你一定已经看明白了，你可以自行写一个程序，跑下你之前的接口格式，跑成这样的json文件就可以了。


</p>